Web API: The Good Parts

Web APIをどうやって設計・運用していくと良いのかを示した本

APIって名前はよく聞くけど実はピンと来てなかった。最近APIを使って便利に情報を引き出すというのを少し触れたということもあり、APIに関してまとまった情報をインプットしようということで手に取った本

何度か読み返したいなと思った

Web APIを美しく設計した方がいい4つの理由

設計の美しいWeb APIは使いやすい

設計の美しいWeb APIは変更しやすい

設計の美しいWeb APIは頑強である

設計の美しいWeb APIは恥ずかしくない

美しさを保つための原則

仕様が決まっているものは仕様に従う

仕様が決まっていないものに関してはデファクトスタンダードに従う

Hackable（ハッカブル：改造しやすい）という言葉を知らなかったので面白かった

命名規則なども事例に触れながら説明してあってわかりやすかった

データフォーマットは、今作るなら基本的にはJSON

トップレベルが配列のJSONはセキュリティのリスクが発生しうるので、オブジェクトで包むのが良さそう

一度公開したAPIはコロコロ変更しない。改善のために新しくしたい場合にはバージョン管理する

巻末付録BのWeb APIチェックリストはコンパクトに確認事項がまとまっていてとても良い、 APIを開発する際に確認したい

ちょくちょく上記メモしたけど、一番の収穫は下記↓

scaffoledを使うとrespond_toでhtmlとjsonの両方が自動生成される。Railsを学び始めた当初は「使うのはhtmlであることがほとんどだと思うけど、なんでjsonも一緒に生成されるのがデフォルトになっているんだろう？」くらいに思っていたけど、この本を読んだことと、別のところでAPIを触る機会がほんの少しあって、jsonで返すのはAPIじゃん！ということにようやく気付けたのがとても良い体験だった